Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update fusionreport score calculation documentation #1

Open
wants to merge 1,829 commits into
base: master
Choose a base branch
from

Conversation

KuthuruTejaswini
Copy link

Resolves nf-core#555

Updates documentation to reflect new fusionreport score calculation:

  • Added detailed explanation of new scoring system
  • Documented 80/20 weight distribution between tool detection and database hits
  • Added formula for score calculation

PR checklist

  • This comment contains a description of changes (with reason)
  • If you've fixed a bug or added code that should be tested, add tests!
  • If necessary, also make a PR on the nf-core/rnafusion branch on the nf-core/test-datasets repo
  • Ensure the test suite passes (nextflow run . -profile test,docker).
  • Make sure your code lints (nf-core lint .).
  • Documentation in docs is updated
  • CHANGELOG.md is updated
  • README.md is updated

Learn more about contributing: CONTRIBUTING.md

alanmmobbs93 and others added 30 commits December 5, 2024 14:25
Updated tests and fusion containers and conda versions, general confi…
Change `FUSIONCATCHER_DOWNLOAD` docker image to Seqera container
atrigila and others added 24 commits January 8, 2025 09:37
…rences

Add pipeline-level nf-test (`BUILD_REFERENCES`)
Add nf-test for local module `FUSIONINSPECTOR`
Important! Template update for nf-core/tools v3.1.2
…test

Add nf-test for `fusionreport_workflow` subworkflow
Important! Template update for nf-core/tools v3.2.0
@KuthuruTejaswini
Copy link
Author

This PR addresses the documentation updates requested in that issue nf-core#555

@atrigila
Copy link

Hi @KuthuruTejaswini, could you make this PR against the dev branch of https://github.com/nf-core/rnafusion? Currently it is against rannick's fork. Thank you.

@KuthuruTejaswini KuthuruTejaswini force-pushed the docs/update-fusionreport-score branch from defd621 to 8906966 Compare February 21, 2025 01:07
- Add detailed explanation of new scoring system
- Document 80/20 weight distribution between tool detection and database hits
- Add formula for score calculation
@KuthuruTejaswini KuthuruTejaswini force-pushed the docs/update-fusionreport-score branch from 8906966 to 659fa0b Compare February 21, 2025 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation should reflect fusionreport score metric change
9 participants